.\"
.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
.\" permission to reproduce portions of its copyrighted documentation.
.\" Original documentation from The Open Group can be obtained online at
.\" http://www.opengroup.org/bookstore/.
.\"
.\" The Institute of Electrical and Electronics Engineers and The Open
.\" Group, have given us permission to reprint portions of their
.\" documentation.
.\"
.\" In the following statement, the phrase ``this text'' refers to portions
.\" of the system documentation.
.\"
.\" Portions of this text are reprinted and reproduced in electronic form
.\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
.\" Standard for Information Technology -- Portable Operating System
.\" Interface (POSIX), The Open Group Base Specifications Issue 6,
.\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
.\" Engineers, Inc and The Open Group.  In the event of any discrepancy
.\" between these versions and the original IEEE and The Open Group
.\" Standard, the original IEEE and The Open Group Standard is the referee
.\" document.  The original Standard can be obtained online at
.\" http://www.opengroup.org/unix/online.html.
.\"
.\" This notice shall appear on any product containing this material.
.\"
.\" The contents of this file are subject to the terms of the
.\" Common Development and Distribution License (the "License").
.\" You may not use this file except in compliance with the License.
.\"
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
.\" or http://www.opensolaris.org/os/licensing.
.\" See the License for the specific language governing permissions
.\" and limitations under the License.
.\"
.\" When distributing Covered Code, include this CDDL HEADER in each
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
.\" If applicable, add the following below this CDDL HEADER, with the
.\" fields enclosed by brackets "[]" replaced with your own identifying
.\" information: Portions Copyright [yyyy] [name of copyright owner]
.\"
.\"
.\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
.\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
.\"
.TH UTMPX.H 3HEAD "Apr 16, 2007"
.SH NAME
utmpx.h, utmpx \- user accounting database definitions
.SH SYNOPSIS
.LP
.nf
#include <utmpx.h>
.fi

.SH DESCRIPTION
.sp
.LP
The \fB<utmpx.h>\fR header defines the \fButmpx\fR structure, which includes
the following members:
.sp
.in +2
.nf
char                  ut_user[];  /* user login name */
char                  ut_id[];    /* unspecified initialization */
                                  /* process identifier */
char                  ut_line[];  /* device name */
pid_t                 ut_pid;     /* process ID */
short                 ut_type;    /* type of entry */
.fi
.in -2

.sp
.LP
for X/Open compilation environments:
.sp
.in +2
.nf
struct ut_exit_status ut_exit; /* process termination/exit status*/
.fi
.in -2

.sp
.LP
for all other compilation environments:
.sp
.in +2
.nf
struct exit_status    ut_exit;    /* process termination/exit status*/
.fi
.in -2

.sp
.in +2
.nf
struct timeval        ut_tv;      /* time entry was made */
int                   ut_session; /* session ID, used for windowing */
short                 ut_syslen;  /* significant length of ut_host */
                                  /* including terminating null */
char                  ut_host[];  /* remote host name */
.fi
.in -2

.sp
.LP
The \fBpid_t\fR type is defined through \fBtypedef\fR as described in
\fB<sys/types.h>\fR.
.sp
.LP
The \fBtimeval\fR structure is defined as described in \fB<sys/time.h>\fR.
.sp
.LP
Inclusion of the \fB<utmpx.h>\fR header can also make visible all symbols from
\fB<sys/time.h>\fR.
.sp
.LP
The following symbolic constants are defined as possible values for the
\fBut_type\fR member of the \fButmpx\fR structure:
.sp
.ne 2
.na
\fB\fBEMPTY\fR\fR
.ad
.RS 17n
No valid user accounting information.
.RE

.sp
.ne 2
.na
\fB\fBBOOT_TIME\fR\fR
.ad
.RS 17n
Identifies time of system boot.
.RE

.sp
.ne 2
.na
\fB\fBOLD_TIME\fR\fR
.ad
.RS 17n
Identifies time when system clock changed.
.RE

.sp
.ne 2
.na
\fB\fBNEW_TIME\fR\fR
.ad
.RS 17n
Identifies time after system clock changed.
.RE

.sp
.ne 2
.na
\fB\fBUSER_PROCESS\fR\fR
.ad
.RS 17n
Identifies a process.
.RE

.sp
.ne 2
.na
\fB\fBINIT_PROCESS\fR\fR
.ad
.RS 17n
Identifies a process spawned by the \fBinit\fR process.
.RE

.sp
.ne 2
.na
\fB\fBLOGIN_PROCESS\fR\fR
.ad
.RS 17n
Identifies the session leader of a logged-in user.
.RE

.sp
.ne 2
.na
\fB\fBDEAD_PROCESS\fR\fR
.ad
.RS 17n
Identifies a session leader who has exited.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Standard
.TE

.SH SEE ALSO
.sp
.LP
.BR endutxent (3C),
.BR time.h (3HEAD),
.BR types.h (3HEAD),
.BR attributes (7),
.BR standards (7)
